home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection 1998 Fall: Game Toolkit / Disc.iso / SDKs / QuickTime Mac / AIncludes / QD3DSet.a < prev    next >
Encoding:
Text File  |  1998-04-09  |  9.5 KB  |  322 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DSet.a
  3. ;
  4. ;    Contains:    Q3Set types and routines                                            
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    QuickTime 3.0
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__QD3DSET__') = 'UNDEFINED' THEN
  19. __QD3DSET__ SET 1
  20.  
  21.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  22.     include 'QD3D.a'
  23.     ENDIF
  24.  
  25. ; ******************************************************************************
  26. ; **                                                                             **
  27. ; **                                Set Routines                                 **
  28. ; **                                                                             **
  29. ; ****************************************************************************
  30.  
  31. ;
  32. ; extern TQ3SetObject Q3Set_New(void )
  33. ;
  34.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  35.         IMPORT_CFM_FUNCTION Q3Set_New
  36.     ENDIF
  37.  
  38. ;
  39. ; extern TQ3ObjectType Q3Set_GetType(TQ3SetObject theSet)
  40. ;
  41.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  42.         IMPORT_CFM_FUNCTION Q3Set_GetType
  43.     ENDIF
  44.  
  45. ;
  46. ; extern TQ3Status Q3Set_Add(TQ3SetObject theSet, TQ3ElementType theType, const void *data)
  47. ;
  48.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  49.         IMPORT_CFM_FUNCTION Q3Set_Add
  50.     ENDIF
  51.  
  52. ;
  53. ; extern TQ3Status Q3Set_Get(TQ3SetObject theSet, TQ3ElementType theType, void *data)
  54. ;
  55.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  56.         IMPORT_CFM_FUNCTION Q3Set_Get
  57.     ENDIF
  58.  
  59. ;
  60. ; extern TQ3Boolean Q3Set_Contains(TQ3SetObject theSet, TQ3ElementType theType)
  61. ;
  62.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  63.         IMPORT_CFM_FUNCTION Q3Set_Contains
  64.     ENDIF
  65.  
  66. ;
  67. ; extern TQ3Status Q3Set_Clear(TQ3SetObject theSet, TQ3ElementType theType)
  68. ;
  69.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  70.         IMPORT_CFM_FUNCTION Q3Set_Clear
  71.     ENDIF
  72.  
  73. ;
  74. ; extern TQ3Status Q3Set_Empty(TQ3SetObject target)
  75. ;
  76.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  77.         IMPORT_CFM_FUNCTION Q3Set_Empty
  78.     ENDIF
  79.  
  80. ; 
  81. ; *  Iterating through all elements in a set
  82. ; *
  83. ; *  Pass in kQ3ElementTypeNone to get first type
  84. ; *  kQ3ElementTypeNone is returned when end of list is reached
  85. ; 
  86.  
  87. ;
  88. ; extern TQ3Status Q3Set_GetNextElementType(TQ3SetObject theSet, TQ3ElementType *theType)
  89. ;
  90.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  91.         IMPORT_CFM_FUNCTION Q3Set_GetNextElementType
  92.     ENDIF
  93.  
  94.  
  95. ; ******************************************************************************
  96. ; **                                                                             **
  97. ; **                                Attribute Types                                 **
  98. ; **                                                                             **
  99. ; ****************************************************************************
  100.  
  101. ;  
  102. ; *    For the data types listed below, pass in a pointer to it in the _Add 
  103. ; *    and _Get calls.
  104. ; *
  105. ; *    For surface shader attributes, reference counts are incremented on 
  106. ; *    the _Add and _Get 
  107. ; 
  108.  
  109.  
  110. ; typedef long                            TQ3AttributeTypes
  111.                                                             ; Data Type                
  112. kQ3AttributeTypeNone            EQU        0                    ; ---------                
  113. kQ3AttributeTypeSurfaceUV        EQU        1                    ; TQ3Param2D                
  114. kQ3AttributeTypeShadingUV        EQU        2                    ; TQ3Param2D                 
  115. kQ3AttributeTypeNormal            EQU        3                    ; TQ3Vector3D                 
  116. kQ3AttributeTypeAmbientCoefficient EQU    4                    ; float                     
  117. kQ3AttributeTypeDiffuseColor    EQU        5                    ; TQ3ColorRGB                
  118. kQ3AttributeTypeSpecularColor    EQU        6                    ; TQ3ColorRGB                
  119. kQ3AttributeTypeSpecularControl    EQU        7                    ; float                    
  120. kQ3AttributeTypeTransparencyColor EQU    8                    ; TQ3ColorRGB                
  121. kQ3AttributeTypeSurfaceTangent    EQU        9                    ; TQ3Tangent2D              
  122. kQ3AttributeTypeHighlightState    EQU        10                    ; TQ3Switch                 
  123. kQ3AttributeTypeSurfaceShader    EQU        11                    ; TQ3SurfaceShaderObject    
  124. kQ3AttributeTypeNumTypes        EQU        12
  125. ; typedef TQ3ElementType                 TQ3AttributeType
  126.  
  127. ; ******************************************************************************
  128. ; **                                                                             **
  129. ; **                                Attribute Drawing                             **
  130. ; **                                                                             **
  131. ; ****************************************************************************
  132.  
  133. ;
  134. ; extern TQ3Status Q3Attribute_Submit(TQ3AttributeType attributeType, const void *data, TQ3ViewObject view)
  135. ;
  136.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  137.         IMPORT_CFM_FUNCTION Q3Attribute_Submit
  138.     ENDIF
  139.  
  140.  
  141. ; ******************************************************************************
  142. ; **                                                                             **
  143. ; **                            AttributeSet Routines                             **
  144. ; **                                                                             **
  145. ; ****************************************************************************
  146.  
  147. ;
  148. ; extern TQ3AttributeSet Q3AttributeSet_New(void )
  149. ;
  150.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  151.         IMPORT_CFM_FUNCTION Q3AttributeSet_New
  152.     ENDIF
  153.  
  154. ;
  155. ; extern TQ3Status Q3AttributeSet_Add(TQ3AttributeSet attributeSet, TQ3AttributeType theType, const void *data)
  156. ;
  157.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  158.         IMPORT_CFM_FUNCTION Q3AttributeSet_Add
  159.     ENDIF
  160.  
  161. ;
  162. ; extern TQ3Boolean Q3AttributeSet_Contains(TQ3AttributeSet attributeSet, TQ3AttributeType attributeType)
  163. ;
  164.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  165.         IMPORT_CFM_FUNCTION Q3AttributeSet_Contains
  166.     ENDIF
  167.  
  168. ;
  169. ; extern TQ3Status Q3AttributeSet_Get(TQ3AttributeSet attributeSet, TQ3AttributeType theType, void *data)
  170. ;
  171.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  172.         IMPORT_CFM_FUNCTION Q3AttributeSet_Get
  173.     ENDIF
  174.  
  175. ;
  176. ; extern TQ3Status Q3AttributeSet_Clear(TQ3AttributeSet attributeSet, TQ3AttributeType theType)
  177. ;
  178.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  179.         IMPORT_CFM_FUNCTION Q3AttributeSet_Clear
  180.     ENDIF
  181.  
  182. ;
  183. ; extern TQ3Status Q3AttributeSet_Empty(TQ3AttributeSet target)
  184. ;
  185.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  186.         IMPORT_CFM_FUNCTION Q3AttributeSet_Empty
  187.     ENDIF
  188.  
  189. ; 
  190. ; * Q3AttributeSet_GetNextAttributeType
  191. ; *
  192. ; * Pass in kQ3AttributeTypeNone to get first type
  193. ; * kQ3AttributeTypeNone is returned when end of list is reached
  194. ; 
  195.  
  196. ;
  197. ; extern TQ3Status Q3AttributeSet_GetNextAttributeType(TQ3AttributeSet source, TQ3AttributeType *theType)
  198. ;
  199.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  200.         IMPORT_CFM_FUNCTION Q3AttributeSet_GetNextAttributeType
  201.     ENDIF
  202.  
  203. ;
  204. ; extern TQ3Status Q3AttributeSet_Submit(TQ3AttributeSet attributeSet, TQ3ViewObject view)
  205. ;
  206.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  207.         IMPORT_CFM_FUNCTION Q3AttributeSet_Submit
  208.     ENDIF
  209.  
  210. ; 
  211. ; * Inherit from parent->child into result
  212. ; *    Result attributes are:
  213. ; *        all child attributes + all parent attributes NOT in the child
  214. ; 
  215.  
  216. ;
  217. ; extern TQ3Status Q3AttributeSet_Inherit(TQ3AttributeSet parent, TQ3AttributeSet child, TQ3AttributeSet result)
  218. ;
  219.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  220.         IMPORT_CFM_FUNCTION Q3AttributeSet_Inherit
  221.     ENDIF
  222.  
  223.  
  224. ; ******************************************************************************
  225. ; **                                                                             **
  226. ; **                            Custom Element Registration                         **
  227. ; **                                                                             **
  228. ; ****************************************************************************
  229.  
  230. ; 
  231. ; * Element Methods - 
  232. ; *
  233. ; *         When you create a custom element, you control what structures are 
  234. ; *        passed around the API. For example, you may allow the Q3Set_Add call 
  235. ; *        take one type of argument, store your element internally in some 
  236. ; *        abstract data type, and have the Q3Set_Get call take a different 
  237. ; *        argument.
  238. ; *
  239. ; *        For example:
  240. ; *            
  241. ; *        There are four calls which at some point will copy an element:
  242. ; *
  243. ; *        Q3Set_Add (copied from Application memory to QuickDraw3D memory)
  244. ; *        Q3Set_Get (copied from QuickDraw3D memory to Application memory)
  245. ; *        Q3Object_Duplicate (all elements are copied internally)
  246. ; *        Q3AttributeSet_Inherit (all elements are copied internally)
  247. ; *
  248. ; *         Either CopyAdd or CopyReplace is called during the "_Add" call.
  249. ; *            - CopyAdd is destructive and should assume "toElement" is garbage
  250. ; *            - CopyReplace is replacing an existing element.
  251. ; *
  252. ; *         CopyGet is called during the "_Get" call.
  253. ; *
  254. ; *         CopyDuplicate is called to duplicate an element's internal structure.
  255. ; *
  256. ; * Attributes Methods - 
  257. ; *
  258. ; *        For copying data while Inheriting. Element methods are used
  259. ; *        at all other times.
  260. ; *    
  261. ; *         CopyInherit is called to duplicate an element's internal structure 
  262. ; *            during inheritance. You should make this as fast as possible.
  263. ; *            (for example, if your custom element contains objects, you
  264. ; *             should do a Q3Shared_GetReference instead of a Q3Object_Duplicate)
  265. ; *            
  266. ; *        The ElementDelete method will be called for all of your elements 
  267. ; *        copied around via CopyAdd, CopyReplace, CopyDuplicate, and 
  268. ; *        CopyInherit.
  269. ; *        If CopyGet allocates any memory in it's destination, it is up to the 
  270. ; *        application to delete it on its side.
  271. ; 
  272.  
  273.  
  274. kQ3XMethodTypeElementCopyAdd    EQU        'ecpa'
  275. kQ3XMethodTypeElementCopyReplace EQU    'ecpr'
  276. kQ3XMethodTypeElementCopyGet    EQU        'ecpg'
  277. kQ3XMethodTypeElementCopyDuplicate EQU    'eccd'
  278. kQ3XMethodTypeElementDelete        EQU        'ecpl'
  279. ;
  280. ; extern TQ3XObjectClass Q3XElementClass_Register(TQ3ElementType *elementType, const char *name, unsigned long sizeOfElement, TQ3XMetaHandler metaHandler)
  281. ;
  282.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  283.         IMPORT_CFM_FUNCTION Q3XElementClass_Register
  284.     ENDIF
  285.  
  286. ;
  287. ; extern TQ3Status Q3XElementType_GetElementSize(TQ3ElementType elementType, unsigned long *sizeOfElement)
  288. ;
  289.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  290.         IMPORT_CFM_FUNCTION Q3XElementType_GetElementSize
  291.     ENDIF
  292.  
  293.  
  294. ; ******************************************************************************
  295. ; **                                                                             **
  296. ; **                        Custom Attribute Registration                         **
  297. ; **                                                                             **
  298. ; ****************************************************************************
  299.  
  300. ; typedef TQ3Boolean                     TQ3XAttributeInheritMethod
  301.  
  302. ;  return kQ3True or kQ3False in your metahandler 
  303. ;
  304. ; extern TQ3XObjectClass Q3XAttributeClass_Register(TQ3AttributeType *attributeType, const char *creatorName, unsigned long sizeOfElement, TQ3XMetaHandler metaHandler)
  305. ;
  306.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  307.         IMPORT_CFM_FUNCTION Q3XAttributeClass_Register
  308.     ENDIF
  309.  
  310. ; 
  311. ; *    Version 1.5
  312. ; 
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.     ENDIF ; __QD3DSET__ 
  321.  
  322.